home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 19 / Night Owl (The Best of Shareware)(NOPV 19)(1996).ISO / 007a / sfnetfs.zip / SFNETFS.DOC < prev    next >
Text File  |  1995-12-09  |  18KB  |  438 lines

  1. ════════════════════════════════════════
  2. SFNET File System v1.0  *FREEWARE*
  3. By: Ross Cassell Of Cornerware Utilities
  4. (C) Copyright 1995, All Rights Reserved
  5. ════════════════════════════════════════
  6. *NOTE*
  7.  
  8. This doc file will be long winded, but should explain everything to you?
  9.  
  10. Introduction
  11. ------------
  12.  
  13. SFNET File System is a tool to assist the SFNET Area Code Hub in insuring
  14. that they pass onward to their downlinks any files which may be sent down
  15. from the SFNET International Hub. Normally the SPITFIRE newsletter, SFNET
  16. listings and an occasional update to the SHILOH software are commonly sent
  17. down. It is of course the Area Code Hubs responsibility to see to it that
  18. these files make it past them and on to their downlinks. In one of the more
  19. recent versions of the SHILOH software, Mike Woltz added into the SHILOIMP
  20. module the ability for it to search the incoming mail bundle for a *.ZIP
  21. file and subsequently extract it. This allows the hubs to include within
  22. the QWK's any ZIP files, so that the downlink gets them. The most basic way
  23. to do this was in a batch file, to put the file you want to send somewhere,
  24. then use a 'IF EXIST' statement, if so, then you would simply make a call
  25. to PKZIP to add the ZIP to the downlinks QWK file. The problem is that a
  26. presumption is made that every downlink will call in at that time, but
  27. there are those who dont, be it phone costs, not being able to get on, and a
  28. myriad of other legit excuses. This causes some problems, because the Hub
  29. Sysop has to do some manual intervening, s/he cant leave the ZIP file in
  30. there forever, you would be sending the same file over and over again to
  31. some downlinks and when the ZIP got removed, some downlinks would never
  32. receive them when they did call, Some Area Code Hubs only put the ZIP file
  33. in place for one night and then remove it the next, murphys law sez that
  34. someone is bound to miss out?
  35.  
  36. In Comes SFNET File System, it will help you distribute the files, keep
  37. track of who got the files and more!! SFNET File System, does a lot of the
  38. work for you but not all of it.
  39.  
  40. Conventions And Limitations
  41. ===========================
  42.  
  43. This utility is meant to automate some of the duties you have as an SFNET
  44. area code hub, but is not meant to absolve you of those responsibilities.
  45. It is hoped that you will still pursue your duties as a hub with complete
  46. diligence <sp> even if you have just one downlink or 100.. SFNET File
  47. system is a tool not a slave.
  48.  
  49. This utility is designed solely around SFNET and the concept and structure
  50. used by SFNET. The 3 utilities that comprise this program, must be located
  51. in the same directory as the SHILOH software or they will refuse to run.
  52. The main configuration program will read in your SHILOH.CFG file, it will
  53. look at the 5th line of that file to obtain you SFNET address, if it finds
  54. that the last 3 characters of that address is not '000' then it will refuse
  55. to run. If you are not a SFNET area code hub, then this software will have
  56. no application for you.
  57.  
  58. What It Does And Usage
  59. ======================
  60.  
  61. SFNET File System comes as 3 separate utilities:
  62.  
  63. SFNFSCFG.EXE
  64.  
  65. Main configuration Program and Node Editor.
  66.  
  67. FROMINTL.EXE
  68.  
  69. Utility that is run after you import your QWK packet from the International
  70. Hub.
  71.  
  72. TONODES.EXE
  73.  
  74. Utility that is run after the QWK packet is created for the Downlink but
  75. before it gets sent.
  76.  
  77. Well Lets get Started!!
  78.  
  79. First off, locate these 3 EXE's in the same exact directory that contains,
  80. the SHILOH software, which would be SHILOIMP.COM, SHILOEXP.COM and
  81. SHILOH.CFG. (Remember if they cant find SHILOH.CFG, then they wont run)
  82.  
  83. First thing to do is to run SFNSCFG.EXE, this utility will test to make
  84. sure SHILOH.CFG exists and then check if you are a HUB based on your SFNET
  85. address, once those tests have been passed you are at the primary menu.
  86. During this process, SFNFSCFG will have created two subdirectories for you
  87. (if they did not previously exist). If your SHILOH directory is:
  88.  
  89. C:\SHILOH
  90.  
  91. Then NODEFILE and HUBFILE directories are created underneath SHILOH.
  92.  
  93. C:\SHILOH\NODEFILE\
  94. C:\SHILOH\HUBFILE\
  95.  
  96. Step [1]
  97.  
  98. Select Option <A> Add A Node To Your DataBase
  99.  
  100. You will note that the command prompt will automatically add in the first 5
  101. characters of their SFNET address as it would pertain to your Area Code.
  102. (This INFO is obtained from your SHILOH.CFG file.)
  103. Simply input the last 3 characters of the nodes address and press Enter,
  104. simply continue to do so, until all of the addresses are entered into the
  105. database that comprise all of your downlinks. Remember to not ENTER in your
  106. own address as there is no need to. When you are done simply press ENTER
  107. without making an ENTRY and you will be returned to the Main Menu.
  108.  
  109. *NOTE* A new entry will replace the first vacant entry encountered.
  110.  
  111.        If the Database file (DOWNLINK.DAT) does not exist, it will be
  112.        created with a VACANT entry as the first record.
  113.  
  114.        If you delete a node from the database, that nodes record will be
  115.        converted to VACANT.
  116.  
  117.        You will not be able to add a node if they already exist in the
  118.        database.
  119.  
  120.        Each new entry is obviously started out with a File Status of FALSE.
  121.  
  122. There is more to SFNFSCFG, but will be discussed later. For Now Press <Q>
  123. to quit and return to the DOS prompt.
  124.  
  125. Step [2]
  126.  
  127. It is assumed that you have PKZIP in your Path, if not correct it. <g>
  128.  
  129. To complete installation you will need to edit your batch files used to
  130. fetch mail frim the International hub and send mail to the nodes, this is
  131. where FROMINTL.EXE and TONODES.EXE come in.
  132.  
  133. In the batch file that you use to fetch mail from the International Hub
  134. place FROMINTL.EXE in after the SHILOIMP statement, like so:
  135.  
  136. SHILOIMP A0000000.QWK
  137. FROMINTL
  138.  
  139. In the batch file you use to let the nodes come in to get their mail, place
  140. TONODES.EXE after their packet is created, but before you have DSZ send it,
  141. like so:
  142.  
  143. SHILOEXP A0???000.QWK
  144. TONODES
  145. DSZ sz A0???000.QWK
  146.  
  147. Wham Bam Thank You maam, Installation is Complete!!
  148.  
  149. How It Works And How To Work It?
  150. ================================
  151.  
  152. SFNFSCFG:
  153.  
  154. The main configuration program is used to create the needed subdirectories,
  155. create a database file (DOWNLINK.DAT) in which your downlinks may be added
  156. to it, deleted from it or file status altered? The configuration program
  157. may also be used to delete the database.
  158.  
  159. DOWNLINK.DAT is a simple binary data file that would contain individual
  160. records of your downlinks. Each record contains only two items, their node
  161. id and a True/False string that denotes their file status. (TRUE means they
  162. got the latest files, FALSE means they did not) DOWNLINK.DAT is initially
  163. created by the main Configuration program but is also relied on and written
  164. to, by the FROMINTL.EXE and TONODES.EXE utilities.
  165.  
  166. Below is the main menu for SFNFSCFG:
  167.  
  168.          ╓───────────────────────────────────────────────────────────╖
  169.          ║                 SFNET File System v1.0                    ║
  170.          ║           (C) Copyright 1995 by Ross Cassell              ║
  171.          ║      The Dark Corner BBS (864)573-7069 SupraFax 28.8      ║
  172.          ╙───────────────────[DESQview Detected]─────────────────────╜
  173.  
  174.                 - [Configuration Menu For SFNET Hub A0803000] -
  175.  
  176. <A> Add Node To Your Database
  177. <V> View Nodes In Your Database
  178. <T> Toggle A Nodes File Status
  179. <D> Delete A Node From Your DataBase
  180. <R> Remove Your DownLink DataBase File (Start Over)
  181.  
  182. <Q> Quit
  183.  
  184. Enter Selection [ A V T D R Q ]?
  185.  
  186. Commands Explained:
  187.  
  188. <A> Add Node To Your Database
  189.  
  190. This is used to ADD nodes to the database file, here is what the prompt
  191. will look like:
  192.  
  193.          ╓───────────────────────────────────────────────────────────╖
  194.          ║                 SFNET File System v1.0                    ║
  195.          ║           (C) Copyright 1995 by Ross Cassell              ║
  196.          ║      The Dark Corner BBS (864)573-7069 SupraFax 28.8      ║
  197.          ╙───────────────────[DESQview Detected]─────────────────────╜
  198.  
  199. Entries: 1
  200. #  Downlink     File Status
  201. ═══════════════════════════
  202. 1) A0803003        TRUE
  203.  
  204. Enter Downlink Node ID To Add [Enter Quits]: A0803
  205.  
  206.  
  207. Note how the command prompt adds in the first 5 characters for you? Simply
  208. input the last 3 characters of the downlinks node ID and press ENTER and
  209. continue to do so, until all links are entered, then Press ENTER without
  210. making an entry to return to the main menu. You will not be able to enter
  211. in a existing link, nor should you enter in your own address. When adding
  212. in an entry, the first VACANT record will be used for the new entry.
  213.  
  214. When Entries total 10 or more, it will scroll to the next screen until
  215. presented with a command prompt.
  216.  
  217. <V> View Nodes In Your Database
  218.  
  219. This is simply a way for you to go in and spot check your node entries to
  220. insure correctness or verify file status?
  221.  
  222. When Entries total 10 or more, it will scroll to the next screen until
  223. presented with a command prompt.
  224.  
  225. Below is what the View feature looks like:
  226.  
  227.          ╓───────────────────────────────────────────────────────────╖
  228.          ║                 SFNET File System v1.0                    ║
  229.          ║           (C) Copyright 1995 by Ross Cassell              ║
  230.          ║      The Dark Corner BBS (864)573-7069 SupraFax 28.8      ║
  231.          ╙───────────────────[DESQview Detected]─────────────────────╜
  232.  
  233. Entries: 1
  234. #  Downlink     File Status
  235. ═══════════════════════════
  236. 1) A0803003        TRUE
  237.  
  238. <ENTER>
  239.  
  240.  
  241. <T> Toggle A Nodes File Status
  242.  
  243. This feature allows you to toggle a nodes file status back and forth from
  244. TRUE or FALSE, this would allow you to resend ZIP files to a node who may
  245. have had a failed transfer..
  246.  
  247. Below is what the TOGGLE screen looks like:
  248.  
  249.          ╓───────────────────────────────────────────────────────────╖
  250.          ║                 SFNET File System v1.0                    ║
  251.          ║           (C) Copyright 1995 by Ross Cassell              ║
  252.          ║      The Dark Corner BBS (864)573-7069 SupraFax 28.8      ║
  253.          ╙───────────────────[DESQview Detected]─────────────────────╜
  254.  
  255. Entries: 1
  256. #  Downlink     File Status
  257. ═══════════════════════════
  258. 1) A0803003        TRUE
  259.  
  260. Enter Node ID To Toggle: [Enter Quits] A0803
  261.  
  262. When Entries total 10 or more, it will scroll to the next screen until
  263. presented with a command prompt.
  264.  
  265. <D> Delete A Node From Your DataBase
  266.  
  267. This is used to remove a node from the DATABASE, such as when a node quits
  268. SFNET or for whatever reason? When removed the NODES record is replaced
  269. with VACANT and file Status is set to TRUE:
  270.  
  271. Here is what the screen looks like:
  272.  
  273.          ╓───────────────────────────────────────────────────────────╖
  274.          ║                 SFNET File System v1.0                    ║
  275.          ║           (C) Copyright 1995 by Ross Cassell              ║
  276.          ║      The Dark Corner BBS (864)573-7069 SupraFax 28.8      ║
  277.          ╙───────────────────[DESQview Detected]─────────────────────╜
  278.  
  279. Entries: 1
  280. #  Downlink     File Status
  281. ═══════════════════════════
  282. 1) A0803003        TRUE
  283.  
  284. Enter Node ID To Remove: [Enter Quits] A0803
  285.  
  286. When Entries total 10 or more, it will scroll to the next screen until
  287. presented with a command prompt.
  288.  
  289.  
  290. <R> Remove Your DownLink DataBase File (Start Over)
  291.  
  292. Use this function to remove the whole database file, usually you would do
  293. so if you messed up on entering the info, or if you changed area codes
  294. etc..
  295.  
  296. Here is what that screen looks like:
  297.  
  298.          ╓───────────────────────────────────────────────────────────╖
  299.          ║                 SFNET File System v1.0                    ║
  300.          ║           (C) Copyright 1995 by Ross Cassell              ║
  301.          ║      The Dark Corner BBS (864)573-7069 SupraFax 28.8      ║
  302.          ╙───────────────────[DESQview Detected]─────────────────────╜
  303.  
  304. **CAUTION**
  305. By Removing The Existing DataBase, Means You Will Have To Start Over!!
  306. Are You Sure You Want To Remove Your Existing Database [Y/n]?:
  307.  
  308.  
  309. FROMINTL:
  310.  
  311. **SPECIAL NOTE**
  312.  
  313. As mentioned earlier, SFNFSCFG will create the needed directories for SFNET
  314. File System to do its thing. No need to worry, FROMINTL has the same
  315. ability should you accidentally remove them.
  316.  
  317. This utility first looks to see if it can find SHILOH.CFG, then it looks
  318. for DOWNLINK.DAT, if both or either are not found, it will halt, With a 5
  319. second delay. If both of the above files are found it will proceed to look
  320. for *.ZIP in its current directory, if no ZIP files were found it halts and
  321. takes no action. If ZIP files were found it does the following:
  322.  
  323. FROMINTL makes a call to PKZIP and creates 2 ZIP files of the same name,
  324. one ZIP file is created in the NODEFILE directory, the other in the HUBFILE
  325. directory. (The HUBFILE directory is usefull for insuring that you the HUB
  326. SYSOP has backup copies of the incoming ZIPS)
  327.  
  328. The ZIP files will be named according to the current date as reported by
  329. your system, otherwards if the current date is 12-09-95 then the ZIP file
  330. will be named DEC0995.ZIP, If the date was 01-05-96 then the file would be
  331. named JAN0596.ZIP and so on.
  332.  
  333. The Source ZIPS would be zipped up into the two new ZIP files and then the
  334. SOURCE ZIP files will be deleted.
  335.  
  336. After ZIPPING and deleting has been accomplished, then FROMINTL will
  337. rewrite DOWNLINK.DAT to change all your Downlinks File status flags
  338. to FALSE.
  339.  
  340. and so it goes..:)
  341.  
  342. TONODES:
  343.  
  344. This utility like FROMINTL, looks for SHILOH.CFG and DOWNLINK.DAT and
  345. checks to see if they exist, if not it will halt with a 5 second delay.
  346. TONODES also relies on SFDOORS.DAT to obtain the calling Nodes ID.. If
  347. SFDOORS.DAT is not found, TONODES then will see if you specified a NODE ID
  348. on its command line (For those hubs who prescan), if this fails TONODES
  349. will halt with a 5 second delay. After the above tests have passed TONODES
  350. will do the following:
  351.  
  352. It will check the NODEFILE directory for the existence of any of the ZIP
  353. files that FROMINTL created, if none are found, TONODES halts and takes no
  354. action. If a ZIP file is found, it will match up the NODE ID of the NODE as
  355. presented via SFDOORS.DAT or Command line with that in the DOWNLINK.DAT
  356. file, if that NODES file status should already be true, then TONODES will
  357. halt and take no action, should the nodes File status be FALSE, then a call
  358. is made to PKZIP to add the ZIP file to the QWK created by SHILOEXP. (The
  359. QWK name is determined by your NODE ID in your SHILOH.CFG file, if you are
  360. prescanning then the QWK name would be the NODE ID + .QWK of the affected
  361. node, see prescan section) After the ZIP file has been added to the QWK,
  362. then the NODES file status is switched to TRUE.
  363.  
  364. And So it Goes :)
  365.  
  366. *Prescanning*
  367.  
  368. If you are pre-scanning the mail packets for your nodes usage is as
  369. follows:
  370.  
  371. SHILOEXP /PRE=A0803020
  372. REN A0803000.QWK A0803020.QWK
  373. TONODES A0803020
  374.  
  375. The /PRE= command for SHILOEXP tells SHILOEXP to create A0803000.QWK for
  376. node A0803020 without the benifit of SFDOORS.DAT. Since I prescan mail
  377. packets for several people myself in SFNET, I rename their QWK packet to
  378. match their NODE ID, and this is how I have it coded for prescan
  379. consideration in TONODES.EXE. You then RENAME the mail packet to match the
  380. node id of that node, then run TONODES with that NODE ID as the command
  381. line. This will have the same effect and function as it does if the node
  382. was calling in via the standard scripted method. Keep in mind that when I
  383. prescan, it is under the assumption that the node is going to poll for the
  384. packet, therefore if a existing QWK packet is still present from a previous
  385. prescan run, I dont create another QWK. I have things setup to delete
  386. successfully sent QWK's. This practice insures that the downlinks do
  387. receive all that they possibly can.
  388.  
  389. Other Considerations?
  390. =====================
  391.  
  392. As emphasized earlier, this utility will not absolve you of your duties as
  393. an Area Code Hub. This program does not remove the ZIP files it creates, so
  394. you will have to manually go in and be aware of any ZIP files in the
  395. NODEFILE directory, making sure all NODES have received it by viewing their
  396. status, then after a period of time determined by you, remove any older
  397. ZIPS, because you could end up resending older ZIPS.. Like for example:
  398. DEC1095.ZIP could still be there when a JAN1096.ZIP gets created, then in
  399. this case both would get sent, even though DEC1095.ZIP was sent earlier. So
  400. hold yourself and your downlinks accountable for their respective
  401. responsibilities, by expecting them to call daily if they want mail and
  402. yourself by staying up to date. SFNET FIle System is designed to automate
  403. some of your duties, but not replace them.
  404.  
  405. Credits
  406. =======
  407. Turbo Pascal Is (C) Copyright Of Borland International.
  408.  
  409. Spitfire, Shiloh and SFNET are Copyrighted Trademarks By Mike Woltz of
  410. Buffalo Creek Software. (Thanks Mike)
  411.  
  412. Special Thanks Go Out To:
  413.  
  414. Kevin Cummins for providing some programming code for which SFNET File
  415. System Is based on.
  416.  
  417. Brian Leiter who endured many of my phone calls to provide help in the
  418. creation of this utility and for providing code SNIPPETS in helping me
  419. develop new file manipulation routines.
  420.  
  421. Jacque Shipley for input and Testing!!
  422.  
  423. Warranty
  424. ========
  425.  
  426. No Warranty is expressed or implied in this utility, usage is at your own
  427. risk. The program should function properly if correctly installed.
  428.  
  429. Support
  430. =======
  431.  
  432. Ross Cassell (Programmer)
  433. The Dark Corner BBS
  434. (864) 573-7069
  435. FIDONET: 1:3652/1
  436.   SFNET: A0803000
  437. (Our Area Code Just Changed, am retaining 803 for the time being.)
  438.